<!DOCTYPE HTML>
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<main role="main">
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span><a id="line.1">/*</a>
<span class="sourceLineNo">002</span><a id="line.2"> * Licensed to the Apache Software Foundation (ASF) under one or more</a>
<span class="sourceLineNo">003</span><a id="line.3"> * contributor license agreements.  See the NOTICE file distributed with</a>
<span class="sourceLineNo">004</span><a id="line.4"> * this work for additional information regarding copyright ownership.</a>
<span class="sourceLineNo">005</span><a id="line.5"> * The ASF licenses this file to You under the Apache License, Version 2.0</a>
<span class="sourceLineNo">006</span><a id="line.6"> * (the "License"); you may not use this file except in compliance with</a>
<span class="sourceLineNo">007</span><a id="line.7"> * the License.  You may obtain a copy of the License at</a>
<span class="sourceLineNo">008</span><a id="line.8"> *</a>
<span class="sourceLineNo">009</span><a id="line.9"> *      http://www.apache.org/licenses/LICENSE-2.0</a>
<span class="sourceLineNo">010</span><a id="line.10"> *</a>
<span class="sourceLineNo">011</span><a id="line.11"> * Unless required by applicable law or agreed to in writing, software</a>
<span class="sourceLineNo">012</span><a id="line.12"> * distributed under the License is distributed on an "AS IS" BASIS,</a>
<span class="sourceLineNo">013</span><a id="line.13"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</a>
<span class="sourceLineNo">014</span><a id="line.14"> * See the License for the specific language governing permissions and</a>
<span class="sourceLineNo">015</span><a id="line.15"> * limitations under the License.</a>
<span class="sourceLineNo">016</span><a id="line.16"> */</a>
<span class="sourceLineNo">017</span><a id="line.17">package org.apache.commons.dbutils;</a>
<span class="sourceLineNo">018</span><a id="line.18"></a>
<span class="sourceLineNo">019</span><a id="line.19">import java.sql.ResultSet;</a>
<span class="sourceLineNo">020</span><a id="line.20">import java.sql.SQLException;</a>
<span class="sourceLineNo">021</span><a id="line.21">import java.util.List;</a>
<span class="sourceLineNo">022</span><a id="line.22">import java.util.Map;</a>
<span class="sourceLineNo">023</span><a id="line.23"></a>
<span class="sourceLineNo">024</span><a id="line.24">/**</a>
<span class="sourceLineNo">025</span><a id="line.25"> * {@code RowProcessor} implementations convert</a>
<span class="sourceLineNo">026</span><a id="line.26"> * {@code ResultSet} rows into various other objects.  Implementations</a>
<span class="sourceLineNo">027</span><a id="line.27"> * can extend {@code BasicRowProcessor} to protect themselves</a>
<span class="sourceLineNo">028</span><a id="line.28"> * from changes to this interface.</a>
<span class="sourceLineNo">029</span><a id="line.29"> *</a>
<span class="sourceLineNo">030</span><a id="line.30"> * @see BasicRowProcessor</a>
<span class="sourceLineNo">031</span><a id="line.31"> */</a>
<span class="sourceLineNo">032</span><a id="line.32">public interface RowProcessor {</a>
<span class="sourceLineNo">033</span><a id="line.33"></a>
<span class="sourceLineNo">034</span><a id="line.34">    /**</a>
<span class="sourceLineNo">035</span><a id="line.35">     * Create an {@code Object[]} from the column values in one</a>
<span class="sourceLineNo">036</span><a id="line.36">     * {@code ResultSet} row.  The {@code ResultSet} should be</a>
<span class="sourceLineNo">037</span><a id="line.37">     * positioned on a valid row before passing it to this method.</a>
<span class="sourceLineNo">038</span><a id="line.38">     * Implementations of this method must not alter the row position of</a>
<span class="sourceLineNo">039</span><a id="line.39">     * the {@code ResultSet}.</a>
<span class="sourceLineNo">040</span><a id="line.40">     *</a>
<span class="sourceLineNo">041</span><a id="line.41">     * @param rs ResultSet that supplies the array data</a>
<span class="sourceLineNo">042</span><a id="line.42">     * @throws SQLException if a database access error occurs</a>
<span class="sourceLineNo">043</span><a id="line.43">     * @return the newly created array</a>
<span class="sourceLineNo">044</span><a id="line.44">     */</a>
<span class="sourceLineNo">045</span><a id="line.45">    Object[] toArray(ResultSet rs) throws SQLException;</a>
<span class="sourceLineNo">046</span><a id="line.46"></a>
<span class="sourceLineNo">047</span><a id="line.47">    /**</a>
<span class="sourceLineNo">048</span><a id="line.48">     * Create a JavaBean from the column values in one {@code ResultSet}</a>
<span class="sourceLineNo">049</span><a id="line.49">     * row.  The {@code ResultSet} should be positioned on a valid row before</a>
<span class="sourceLineNo">050</span><a id="line.50">     * passing it to this method.  Implementations of this method must not</a>
<span class="sourceLineNo">051</span><a id="line.51">     * alter the row position of the {@code ResultSet}.</a>
<span class="sourceLineNo">052</span><a id="line.52">     * @param &lt;T&gt; The type of bean to create</a>
<span class="sourceLineNo">053</span><a id="line.53">     * @param rs ResultSet that supplies the bean data</a>
<span class="sourceLineNo">054</span><a id="line.54">     * @param type Class from which to create the bean instance</a>
<span class="sourceLineNo">055</span><a id="line.55">     * @throws SQLException if a database access error occurs</a>
<span class="sourceLineNo">056</span><a id="line.56">     * @return the newly created bean</a>
<span class="sourceLineNo">057</span><a id="line.57">     */</a>
<span class="sourceLineNo">058</span><a id="line.58">    &lt;T&gt; T toBean(ResultSet rs, Class&lt;? extends T&gt; type) throws SQLException;</a>
<span class="sourceLineNo">059</span><a id="line.59"></a>
<span class="sourceLineNo">060</span><a id="line.60">    /**</a>
<span class="sourceLineNo">061</span><a id="line.61">     * Create a {@code List} of JavaBeans from the column values in all</a>
<span class="sourceLineNo">062</span><a id="line.62">     * {@code ResultSet} rows.  {@code ResultSet.next()} should</a>
<span class="sourceLineNo">063</span><a id="line.63">     * &lt;strong&gt;not&lt;/strong&gt; be called before passing it to this method.</a>
<span class="sourceLineNo">064</span><a id="line.64">     * @param &lt;T&gt; The type of bean to create</a>
<span class="sourceLineNo">065</span><a id="line.65">     * @param rs ResultSet that supplies the bean data</a>
<span class="sourceLineNo">066</span><a id="line.66">     * @param type Class from which to create the bean instance</a>
<span class="sourceLineNo">067</span><a id="line.67">     * @throws SQLException if a database access error occurs</a>
<span class="sourceLineNo">068</span><a id="line.68">     * @return A {@code List} of beans with the given type in the order</a>
<span class="sourceLineNo">069</span><a id="line.69">     * they were returned by the {@code ResultSet}.</a>
<span class="sourceLineNo">070</span><a id="line.70">     */</a>
<span class="sourceLineNo">071</span><a id="line.71">    &lt;T&gt; List&lt;T&gt; toBeanList(ResultSet rs, Class&lt;? extends T&gt; type) throws SQLException;</a>
<span class="sourceLineNo">072</span><a id="line.72"></a>
<span class="sourceLineNo">073</span><a id="line.73">    /**</a>
<span class="sourceLineNo">074</span><a id="line.74">     * Create a {@code Map} from the column values in one</a>
<span class="sourceLineNo">075</span><a id="line.75">     * {@code ResultSet} row.  The {@code ResultSet} should be</a>
<span class="sourceLineNo">076</span><a id="line.76">     * positioned on a valid row before</a>
<span class="sourceLineNo">077</span><a id="line.77">     * passing it to this method.  Implementations of this method must not</a>
<span class="sourceLineNo">078</span><a id="line.78">     * alter the row position of the {@code ResultSet}.</a>
<span class="sourceLineNo">079</span><a id="line.79">     *</a>
<span class="sourceLineNo">080</span><a id="line.80">     * @param rs ResultSet that supplies the map data</a>
<span class="sourceLineNo">081</span><a id="line.81">     * @throws SQLException if a database access error occurs</a>
<span class="sourceLineNo">082</span><a id="line.82">     * @return the newly created Map</a>
<span class="sourceLineNo">083</span><a id="line.83">     */</a>
<span class="sourceLineNo">084</span><a id="line.84">    Map&lt;String, Object&gt; toMap(ResultSet rs) throws SQLException;</a>
<span class="sourceLineNo">085</span><a id="line.85"></a>
<span class="sourceLineNo">086</span><a id="line.86">}</a>




























































</pre>
</div>
</main>
</body>
</html>
